Skip to content

test(app-shell): ratchet the component-props-to-any cast that hid #3025's dead prop, and pin the schema.direction boundary - #3036

Merged
os-zhuang merged 1 commit into
mainfrom
claude/fc-any-ratchet
Jul 30, 2026
Merged

test(app-shell): ratchet the component-props-to-any cast that hid #3025's dead prop, and pin the schema.direction boundary#3036
os-zhuang merged 1 commit into
mainfrom
claude/fc-any-ratchet

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Two follow-ups to #3025, both about stopping that bug from recurring rather than fixing anything new.

1. The ratchet

#3025 removed two const PanelGroup = ResizablePanelGroup as React.FC<any> casts. Those casts weren't incidental to the bug — they caused it. Erasing a component's props to any meant that when react-resizable-panels v4 renamed directionorientation, the stale prop type-checked against nothing and survived an entire major version as a dead prop React forwarded to the DOM.

What makes this worth a gate rather than review vigilance is how both casts were justified:

vite-plugin-dts may not resolve the direction prop type correctly

react-resizable-panels' direction prop type does not always narrow cleanly in our TS config

Neither was true — v4's GroupProps has no direction key at all. The cast reads as a workaround for a toolchain quirk while actually disabling the check that catches a breaking upstream rename. That's precisely the kind of thing that gets re-added in good faith, by someone reasoning exactly as those two comments did.

Repo-wide over packages/<pkg>/src and apps/<app>/src, following the existing *.ratchet.test.ts shape (#2269, ADR-0054) so it runs in the gating pnpm test job. Covers FC / FunctionComponent / ComponentType parameterised with any, React.-qualified or not.

I chose a ratchet test over an ESLint rule deliberately: it matches existing house precedent, runs in a job that already gates, and needs no per-package ESLint config changes while the #2713 lint-gate sweep is still mid-flight.

Current count is zero — which is exactly why now is the moment to set the gate.

It's tested against its own failure modes

A ratchet has two silent ways to become worthless: a scan path that finds nothing, and a regex that quietly stops matching. Both are pinned. The regex test asserts it fires on the exact casts #3025 removed plus spelling variants, and that it does not fire on legitimate neighbours:

as Record<string, any>            → not flagged
as ComponentProps<typeof Button>  → not flagged
const C: React.FC<Props> = …      → not flagged

Proof it bites

Reintroducing the exact cast into custom/navigation-overlay.tsx:

AssertionError: expected [ Array(1) ] to deeply equal []
+   "packages/components/src/custom/navigation-overlay.tsx :: const PanelGroup = ResizablePanelGroup as React.FC<any>;"
 Tests  1 failed | 2 passed (3)

Reverted after testing.

2. The schema.direction boundary comment

renderers/complex/resizable.tsx:24 maps schema.direction onto the library's orientation. It looks exactly like a site #3025 missed — same prop name, same file family. It isn't: direction is ObjectUI's own public authoring vocabulary and appears in stored view metadata, so renaming it to match the library would break every saved resizable schema.

Documented in place, because the next person to grep for direction will land there and reach for the wrong fix.

Verification

  • New ratchet: 3 tests pass; fails correctly on reintroduction (above)
  • Four sibling ratchets (actions-envelope, flow-envelope, no-refresh-key-remount, adr0054): 8 tests pass
  • resizable-orientation + form-field-panes: 15 tests pass
  • pnpm --filter @object-ui/components type-check: clean
  • eslint: exit 0 (2 pre-existing no-explicit-any warnings in complex/resizable.tsx on lines I didn't touch — [key: string]: any in the props type and panel: any in the map; a props index signature is a different thing from a component cast, so the ratchet correctly ignores them)

No changeset — a test and a comment.

🤖 Generated with Claude Code

…3025's dead prop, and pin the schema.direction boundary

Two follow-ups to #3025, both about stopping that bug from recurring.

**The ratchet.** #3025 removed two
`const PanelGroup = ResizablePanelGroup as React.FC<any>` casts. Those
casts were not incidental to the bug — they caused it. Erasing a
component's props to `any` meant that when react-resizable-panels v4
renamed `direction` to `orientation`, the stale prop type-checked against
nothing and survived a whole major version as a dead prop React forwarded
to the DOM. Deleting the casts is what turned it back into a hard TS2322.

What makes this worth a ratchet rather than review vigilance is how both
casts were justified: one blamed vite-plugin-dts for "not resolving the
direction prop type correctly", the other a prop that "does not always
narrow cleanly in our TS config". Neither was true — v4's `GroupProps`
simply has no `direction` key. The cast reads as a workaround for a
toolchain quirk while actually disabling the check that catches a
breaking upstream rename, so it is the kind of thing that gets re-added
in good faith.

Repo-wide over `packages/<pkg>/src` and `apps/<app>/src`, following the
existing `*.ratchet.test.ts` shape (#2269, ADR-0054) so it runs in the
gating `pnpm test` job. Covers `FC` / `FunctionComponent` /
`ComponentType` parameterised with `any`, qualified or not. Current count
is zero, which is why now is the moment to set the gate.

Three tests, because a ratchet has two silent failure modes of its own: a
scan path that finds nothing, and a regex that stops matching. Both are
pinned — the second against the exact casts #3025 removed, plus the
legitimate neighbours it must not fire on (`as Record<string, any>`,
`as ComponentProps<typeof Button>`, `const C: React.FC<Props>`).

**The boundary comment.** `renderers/complex/resizable.tsx` maps
`schema.direction` onto the library's `orientation`. That looks exactly
like a site #3025 missed. It is not: `direction` is ObjectUI's own public
authoring vocabulary and appears in stored view metadata, so renaming it
to match the library would break every saved `resizable` schema. Said so
in place, since the next person to grep for `direction` will land there.

Verified the ratchet actually bites: reintroducing the exact cast into
`custom/navigation-overlay.tsx` fails it with the file and line, and the
four sibling ratchets plus the 15 resizable tests stay green.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectui Ignored Ignored Jul 30, 2026 1:03pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Main entry (gzip) 27.9 KB 350 KB
Entry file index-B8Ji4w6k.js
Status PASS

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 8.20KB 2.97KB
app-shell (runtime-config.js) 7.42KB 2.32KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 7.57KB 2.97KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 1.17KB 0.53KB
auth (AuthProvider.js) 22.10KB 4.37KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.12KB 3.41KB
auth (LoginForm.js) 17.86KB 5.29KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.43KB 2.09KB
auth (SocialSignInButtons.js) 9.60KB 3.89KB
auth (UserMenu.js) 3.40KB 1.22KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 35.76KB 9.11KB
auth (createAuthenticatedFetch.js) 4.37KB 1.69KB
auth (index.js) 2.25KB 1.01KB
auth (org-roles.js) 6.72KB 2.85KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 4.91KB 0.87KB
auth (useIsWorkspaceAdmin.js) 1.61KB 0.85KB
collaboration (CommentThread.js) 18.38KB 4.49KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 3.65KB 1.42KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.25KB 0.53KB
collaboration (useCommentSearch.js) 1.98KB 0.88KB
collaboration (useConflictResolution.js) 7.75KB 1.86KB
collaboration (useMentionNotifications.js) 1.81KB 0.68KB
collaboration (usePresence.js) 6.33KB 1.84KB
collaboration (useRealtimeSubscription.js) 7.91KB 2.01KB
components (index.js) 457.71KB 100.07KB
core (index.js) 2.16KB 0.78KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 134.67KB 34.24KB
fields (index.js) 222.07KB 54.35KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (currency.js) 1.22KB 0.64KB
i18n (i18n.js) 4.32KB 1.77KB
i18n (index.js) 2.46KB 0.96KB
i18n (pickLocalized.js) 1.70KB 0.83KB
i18n (provider.js) 5.37KB 1.72KB
i18n (useObjectLabel.js) 25.17KB 5.80KB
i18n (useSafeTranslation.js) 3.26KB 1.44KB
layout (index.js) 38.45KB 10.67KB
mobile (MobileProvider.js) 0.92KB 0.49KB
mobile (ResponsiveContainer.js) 0.94KB 0.38KB
mobile (breakpoints.js) 1.51KB 0.70KB
mobile (createOfflineDataSource.js) 5.61KB 1.74KB
mobile (index.js) 1.50KB 0.62KB
mobile (offlineQueue.js) 3.91KB 1.35KB
mobile (pwa.js) 0.97KB 0.49KB
mobile (serviceWorker.js) 1.48KB 0.62KB
mobile (serviceWorkerSource.js) 3.41KB 1.48KB
mobile (useBreakpoint.js) 1.54KB 0.65KB
mobile (useGesture.js) 6.96KB 1.98KB
mobile (useOfflineSync.js) 1.99KB 0.72KB
mobile (usePullToRefresh.js) 2.53KB 0.85KB
mobile (useResponsive.js) 0.71KB 0.42KB
mobile (useResponsiveConfig.js) 1.36KB 0.63KB
mobile (useSpecGesture.js) 4.05KB 1.53KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 6.84KB 2.42KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 3.67KB 1.12KB
permissions (evaluator.js) 4.41KB 1.44KB
permissions (index.js) 0.91KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.52KB
permissions (usePermissions.js) 1.55KB 0.71KB
plugin-ai (index.js) 15.71KB 3.79KB
plugin-calendar (index.js) 44.90KB 12.35KB
plugin-charts (index.js) 60.52KB 17.11KB
plugin-chatbot (index.js) 180.09KB 42.72KB
plugin-dashboard (index.js) 111.59KB 28.74KB
plugin-designer (index.js) 210.56KB 42.56KB
plugin-detail (index.js) 221.50KB 54.15KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 106.35KB 25.82KB
plugin-gantt (index.js) 162.26KB 39.53KB
plugin-grid (index.js) 183.96KB 48.23KB
plugin-kanban (index.js) 47.82KB 13.18KB
plugin-list (index.js) 102.39KB 24.18KB
plugin-map (index.js) 16.80KB 5.24KB
plugin-markdown (index.js) 13.65KB 4.67KB
plugin-report (index.js) 40.32KB 10.53KB
plugin-timeline (index.js) 25.75KB 7.32KB
plugin-tree (index.js) 8.36KB 2.81KB
plugin-view (index.js) 85.91KB 20.99KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.90KB 0.85KB
providers (UploadProvider.js) 11.71KB 3.53KB
providers (index.js) 0.44KB 0.22KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 5.67KB 2.37KB
react (LazyPluginLoader.js) 3.77KB 1.33KB
react (SchemaRenderer.js) 19.28KB 6.38KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 1.02KB 0.55KB
sdui-parser (codegen.js) 4.09KB 1.74KB
sdui-parser (index.js) 3.47KB 1.54KB
sdui-parser (parse.js) 10.04KB 2.82KB
sdui-parser (types.js) 0.29KB 0.24KB
sdui-parser (validate.js) 4.69KB 1.48KB
types (ai.js) 0.20KB 0.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 0.99KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (complex.js) 0.20KB 0.18KB
types (crud.js) 0.20KB 0.18KB
types (data-display.js) 0.20KB 0.18KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 0.77KB 0.41KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
types (feedback.js) 0.20KB 0.18KB
types (field-types.js) 0.20KB 0.18KB
types (form.js) 0.20KB 0.18KB
types (index.js) 2.00KB 0.96KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 0.20KB 0.18KB
types (navigation.js) 0.20KB 0.18KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (permissions.js) 0.20KB 0.18KB
types (plugin-scope.js) 0.20KB 0.18KB
types (record-components.js) 0.20KB 0.19KB
types (record-semantics.js) 1.28KB 0.67KB
types (registry.js) 0.20KB 0.18KB
types (reports.js) 0.20KB 0.18KB
types (spec-report.js) 5.04KB 1.93KB
types (system-fields.js) 2.39KB 1.17KB
types (theme.js) 0.20KB 0.18KB
types (ui-action.js) 1.08KB 0.64KB
types (views.js) 0.20KB 0.18KB
types (widget.js) 0.20KB 0.18KB

Size Limits

  • ✅ Core packages should be < 50KB gzipped
  • ✅ Component packages should be < 100KB gzipped
  • ⚠️ Plugin packages should be < 150KB gzipped

@os-zhuang
os-zhuang merged commit c8b7f3d into main Jul 30, 2026
16 checks passed
@os-zhuang
os-zhuang deleted the claude/fc-any-ratchet branch July 30, 2026 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant